/*
 *
 * $Id: DiscoveryEvent.java,v 1.1 2005/05/03 06:36:52 hamada Exp $
 *
 * Copyright (c) 2001 Sun Microsystems, Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *       Sun Microsystems, Inc. for Project JXTA."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA"
 *    must not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact Project JXTA at http://www.jxta.org.
 *
 * 5. Products derived from this software may not be called "JXTA",
 *    nor may "JXTA" appear in their name, without prior written
 *    permission of Sun.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL SUN MICROSYSTEMS  OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of Project JXTA.  For more
 * information on Project JXTA, please see
 * <http://www.jxta.org/>.
 *
 * This license is based on the BSD license adopted by the Apache Foundation.
 *
 * $Id: DiscoveryEvent.java,v 1.1 2005/05/03 06:36:52 hamada Exp $
 *
 */

package net.jxta.discovery;

import java.util.Enumeration;
import java.util.EventObject;

import net.jxta.protocol.DiscoveryResponseMsg;


/**
 *  Container for DiscoveryService events. The source of the event is the
 *  Discovery Service which generated the event.
**/
public class DiscoveryEvent extends EventObject {

  private DiscoveryResponseMsg response=null;
  private int queryID=-1;
  
   /**
    *  Creates a new event
    *
    *  @see net.jxta.protocol.DiscoveryResponseMsg
    *  @see net.jxta.protocol.ResolverResponseMsg
    *
    *  @param source the Discovery Service which generated the event.
    *  @param queryid The query id associated with the response returned in this event
    **/
    public DiscoveryEvent(Object source, DiscoveryResponseMsg response, int queryid) {
        super(source);
        this.response = response;
        this.queryID = queryid;
    }

   /**
    *  Returns the response associated with the event
    *
    *  @return DiscoveryResponseMsg
    *
    *  @see net.jxta.protocol.DiscoveryResponseMsg
    */
   public DiscoveryResponseMsg getResponse() {

       return response;
   }

   /**
    *  Returns the query id associated with the response returned in this event
    *
    *  @return query id associated with the response
    **/
   public int getQueryID() {

       return queryID;
   }
   
   /**
    * Returns an array of advertisements contained in the DiscoveryResponse
    * for this event.
    *
    * @return Enumeration of Advertisements
    **/
   public synchronized Enumeration getSearchResults() {
        
        return response.getAdvertisements();
   }
}
